Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update api doc following audit suggestions #1291

Merged
merged 2 commits into from
Oct 7, 2024
Merged

docs: update api doc following audit suggestions #1291

merged 2 commits into from
Oct 7, 2024

Conversation

gbotrel
Copy link
Collaborator

@gbotrel gbotrel commented Oct 7, 2024

Description

  • Minor API doc edits
  • Remove scs/api.go api comments; godoc will use the one defined in the interface by default which is better.

@gbotrel gbotrel requested review from ivokub and Tabaie October 7, 2024 18:00
ivokub
ivokub approved these changes Oct 7, 2024
View reviewed changes
Copy link
Collaborator

@ivokub ivokub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Covers all the reported issues.

@gbotrel gbotrel merged commit f776f36 into master Oct 7, 2024
5 checks passed
@gbotrel gbotrel deleted the docs/api branch October 7, 2024 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ivokub ivokub ivokub approved these changes

@Tabaie Tabaie Awaiting requested review from Tabaie

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gbotrel @ivokub